Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert Biostrings2classes.Rnw to .Rmd #83

Open
wants to merge 8 commits into
base: devel
Choose a base branch
from

Conversation

villafup
Copy link

@Bioconductor/sweave2rmd for review

@jwokaty jwokaty self-requested a review February 17, 2023 22:47
@jwokaty
Copy link
Contributor

jwokaty commented Feb 17, 2023

@villafup Please remove .Rnw file. I don't think you need to modify the DESCRIPTION because there are other PRs that add BiocStyle

@hpages
Copy link
Contributor

hpages commented Jun 27, 2023

@villafup @jwokaty Where are we standing with this PR?

@jwokaty
Copy link
Contributor

jwokaty commented Jun 27, 2023

We are waiting on some changes from @villafup. I'll slack him :)

@jwokaty jwokaty changed the title Biostrings2classes rmd Convert Biostrings2classes.Rnw to .Rmd Jul 17, 2023
external pointers to store the string data, (2) use bit patterns to
encode the string data, (3) provide the user with a convenient class of
objects where each instance can store a set of views *on the same* big
string (these views being typicallythe matches returned by a search
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space between typicallythe

Comment on lines +37 to +40
However, there is a flaw in the `r Biocpkg('Biostring')` class design that prevents
the search algorithms to return correct information about the matches
(i.e. the views) that they found. The new classes address this issue by
replacing the `r Biocpkg('Biostrings')` class (implemented in `r Biocpkg('Biostrings')` 1) by 2 new
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think lines 37 and 40 (the first reference only) reference an old BioString class, so replace

`r Biocpkg('Biostrings')`

with

BioString

Copy link
Contributor

@jwokaty jwokaty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@villafup Just 3 small changes.

I noticed that it doesn't currently generate the Rmd via R CMD build because VignetteBuild: knitr isn't in this version of the DESCRIPTION file; however, when it's merged, it should create the .Rmd.

It'll be ready for Herve after these changes.

@ahl27
Copy link
Collaborator

ahl27 commented Jun 6, 2024

@hpages @jwokaty what is the status of this and #90 ? Are these still being worked on, and if not, can we merge/close them?

@hpages
Copy link
Contributor

hpages commented Jun 6, 2024

I'm surprised this vignette made it to the sweave2rmd list. It's very old and outdated and doesn't have much value anymore. It was written to document the classes that I introduced when I took over the package and transitioned it from Biostrings 1 to Biostrings 2 about 18 years ago! The only reason it's still around is that Biostrings doesn't have a good general vignette, so I guess having the "Biostrings 2 classes" vignette was better than nothing. However we should start thinking about addressing that @ahl27. In the mean time I think it's ok to close this unless @jwokaty or @villafup oppose. Thanks!

@ahl27
Copy link
Collaborator

ahl27 commented Jun 7, 2024

Sounds good, I'll wait for either of them to chime in to confirm and then we can consider closing it.

Is the other PR still something we need to merge? I can ping you on that PR so the conversation stays localized to the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants